

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Technical reference &mdash; pysisso 0.3.2 documentation</title>
  

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="License" href="../license.html" />
    <link rel="prev" title="Background information" href="../background/index.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html" class="icon icon-home"> pysisso
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Get started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/index.html">How-to guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../background/index.html">Background information</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Technical reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#api-of-the-most-relevant-objects">API of the most relevant objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">pysisso</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Technical reference</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/reference/index.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="technical-reference">
<span id="reference"></span><h1>Technical reference<a class="headerlink" href="#technical-reference" title="Permalink to this headline">¶</a></h1>
<p>This section contains technical details on pysisso. It is meant to be used as a
reference for checking out specific. In particular, the API of the main objects are
presented here. The complete API can be found in <a class="reference internal" href="../py-modindex.html"><span class="std std-ref">API</span></a>.</p>
<div class="section" id="api-of-the-most-relevant-objects">
<h2>API of the most relevant objects<a class="headerlink" href="#api-of-the-most-relevant-objects" title="Permalink to this headline">¶</a></h2>
<p>To be added</p>
<dl class="py class">
<dt id="pysisso.sklearn.SISSORegressor">
<em class="property">class </em><code class="sig-prename descclassname">pysisso.sklearn.</code><code class="sig-name descname">SISSORegressor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ntask</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">task_weighting</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">desc_dim</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">restart</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">rung</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">opset</span><span class="o">=</span><span class="default_value">'(+)(-)'</span></em>, <em class="sig-param"><span class="n">maxcomplexity</span><span class="o">=</span><span class="default_value">10</span></em>, <em class="sig-param"><span class="n">dimclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">maxfval_lb</span><span class="o">=</span><span class="default_value">0.001</span></em>, <em class="sig-param"><span class="n">maxfval_ub</span><span class="o">=</span><span class="default_value">100000.0</span></em>, <em class="sig-param"><span class="n">subs_sis</span><span class="o">=</span><span class="default_value">20</span></em>, <em class="sig-param"><span class="n">method</span><span class="o">=</span><span class="default_value">'L0'</span></em>, <em class="sig-param"><span class="n">L1L0_size4L0</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">fit_intercept</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">metric</span><span class="o">=</span><span class="default_value">'RMSE'</span></em>, <em class="sig-param"><span class="n">nm_output</span><span class="o">=</span><span class="default_value">100</span></em>, <em class="sig-param"><span class="n">isconvex</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">width</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nvf</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vfsize</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vf2sf</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">npf_must</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_max_iter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_tole</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_dens</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_nlambda</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_minrmse</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_warm_start</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_weighted</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">features_dimensions</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>dict<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_custodian</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">True</span></em>, <em class="sig-param"><span class="n">custodian_job_kwargs</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>dict<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">custodian_kwargs</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>dict<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">run_dir</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>None<span class="p">, </span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">'SISSO_dir'</span></em>, <em class="sig-param"><span class="n">clean_run_dir</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pysisso/sklearn.html#SISSORegressor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysisso.sklearn.SISSORegressor" title="Permalink to this definition">¶</a></dt>
<dd><p>SISSO regressor class compatible with scikit-learn.</p>
<dl class="py method">
<dt id="pysisso.sklearn.SISSORegressor.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ntask</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">task_weighting</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">desc_dim</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">restart</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">rung</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">opset</span><span class="o">=</span><span class="default_value">'(+)(-)'</span></em>, <em class="sig-param"><span class="n">maxcomplexity</span><span class="o">=</span><span class="default_value">10</span></em>, <em class="sig-param"><span class="n">dimclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">maxfval_lb</span><span class="o">=</span><span class="default_value">0.001</span></em>, <em class="sig-param"><span class="n">maxfval_ub</span><span class="o">=</span><span class="default_value">100000.0</span></em>, <em class="sig-param"><span class="n">subs_sis</span><span class="o">=</span><span class="default_value">20</span></em>, <em class="sig-param"><span class="n">method</span><span class="o">=</span><span class="default_value">'L0'</span></em>, <em class="sig-param"><span class="n">L1L0_size4L0</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">fit_intercept</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">metric</span><span class="o">=</span><span class="default_value">'RMSE'</span></em>, <em class="sig-param"><span class="n">nm_output</span><span class="o">=</span><span class="default_value">100</span></em>, <em class="sig-param"><span class="n">isconvex</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">width</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nvf</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vfsize</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vf2sf</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">npf_must</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_max_iter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_tole</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_dens</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_nlambda</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_minrmse</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_warm_start</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">L1_weighted</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">features_dimensions</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>dict<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">use_custodian</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">True</span></em>, <em class="sig-param"><span class="n">custodian_job_kwargs</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>dict<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">custodian_kwargs</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>dict<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">run_dir</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>None<span class="p">, </span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">'SISSO_dir'</span></em>, <em class="sig-param"><span class="n">clean_run_dir</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pysisso/sklearn.html#SISSORegressor.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pysisso.sklearn.SISSORegressor.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct SISSORegressor class.</p>
<p>All arguments not listed below are arguments from the SISSO code. For more
information, see <a class="reference external" href="https://github.com/rouyang2017/SISSO">https://github.com/rouyang2017/SISSO</a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>use_custodian</strong> – Whether to use custodian (currently mandatory).</p></li>
<li><p><strong>custodian_job_kwargs</strong> – Keyword arguments for custodian job.</p></li>
<li><p><strong>custodian_kwargs</strong> – Keyword arguments for custodian.</p></li>
<li><p><strong>run_dir</strong> – Name of the directory where SISSO is run. If None, the directory
will be set automatically. It then contains a timestamp and is unique.</p></li>
<li><p><strong>clean_run_dir</strong> – Whether to clean the run directory after SISSO has run.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="../license.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
        <a href="../background/index.html" class="btn btn-neutral float-left" title="Background information" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2020, Matgenix SRL.

    </p>
  </div>
    
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>